Skip to main content

Webhook Integration - Configuration

This page will help you configure webhook integration with GroupLink API.

Prerequisites​

Important

Before configuring webhooks, ensure you have the GroupLink SDK integrated in your mobile application. Without SDK integration, there will be no events to send to your webhook.

  • API Access: Valid GroupLink API credentials
  • HTTPS Endpoint: A webhook endpoint accessible via HTTPS to receive events
  • Event Understanding: Knowledge of which events you want to receive

Required Information for Configuration​

To configure webhook integration, you'll need to provide the following information to the GroupLink team:

1. Webhook Endpoint​

Provide the complete URL of your endpoint that will receive events:

Example: https://api.yourcompany.com/webhooks/grouplink
Automation Platforms

You can use any automation platform or service that supports webhooks to receive GroupLink events. Below are some popular examples, but you're not limited to them - any HTTPS-compatible endpoint will work.

How to create a webhook in Zapier:

  1. Create a new Zap
  2. Choose "Webhooks by Zapier" as trigger
  3. Select "Catch Hook"
  4. Copy the URL generated by Zapier

Endpoint Requirements:

  • Must be accessible via HTTPS
  • Must accept POST requests with content-type application/json
  • Must respond with HTTP 2xx status (200, 201, 204) to confirm receipt
  • Recommended response time: less than 1 second

2. Application Identifier​

The package name (unique identifier) of your application:

  • Android: com.yourcompany.yourapp
  • iOS: com.yourcompany.yourapp
Note

If you have both Android and iOS applications, both package names will be configured by our team to start sending events.

Security and Authentication​

Current Version​

The webhook can be called without authentication, but we strongly recommend implementing security measures on your endpoint to prevent unauthorized access.

API Key Authentication​

  • The API Key will be sent in the request header
  • Header: X-API-Key: your-api-key-here
  • You can validate the origin of requests

Request Format​

All requests sent to your webhook will follow this pattern:

Method: POST Content-Type: application/json Body: JSON with event data (see Event Examples)

Error Handling and Retries​

Behavior on Failure​

  • If your endpoint returns an error (4xx or 5xx status), we will attempt to resend the event, but it's not guaranteed that all events will be resent without loss
  • Number of attempts: up to 3 retries
  • Interval between attempts: 1 minute, 5 minutes, 15 minutes

Recommendations​

  • Implement proper logging on your endpoint for debugging
  • Return status 200 as quickly as possible and process events asynchronously
  • Implement idempotency to handle possible duplicate events

How to Request Configuration​

To start configuring your webhook, send an email to suporte@grouplinkone.com with:

Subject: Webhook Configuration - [Your company name]

Email body:

Company: [Your company name]
Webhook Endpoint: [Your endpoint URL]
Application Package Name: [Your app package name]
Notes: [Any additional relevant information, such as the authentication method you want to use for the webhook]

Our team will process your request and confirm the configuration.

Testing the Integration​

After configuration is completed by our team:

  1. Ensure your application is running
  2. Trigger the events you configured
  3. Verify that events are being received at your endpoint
  4. Validate the event structure as documented in Event Examples

Next Steps​

Support​

If you have questions during configuration, contact us: